/*
 * Copyright (c) 2010, Jim Hollinger
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   * Neither the name of Jim Hollinger nor the names of its contributors
 *     may be used to endorse or promote products derived from this
 *     software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef COMMON_DATACHANNEL_FILECHANNEL_H_
#define COMMON_DATACHANNEL_FILECHANNEL_H_

#include <stdio.h>
#include <string>
#include "datachannel/datachannel.h"

namespace datachannel {

/**
 ****************************************************************************
 * @brief  A class to exchanging data to and from a file.
 ****************************************************************************
**/
class FileChannel : public DataChannel {
  public:
    enum FileAccessMode {
        READ   = 'r',
        WRITE  = 'w'
    };
    enum FileContentType {
        BINARY = 'b',
        TEXT   = 't'
    };

  public:
    explicit FileChannel(logger::Logger *logger);
    virtual ~FileChannel();
    virtual bool open(const std::string &descriptor);
    virtual bool close();
    virtual int read(void *buffer, int maxCount);
    virtual int write(const void *buffer, int count);
    virtual void setFileAccessMode(FileAccessMode mode);
    virtual void setFileContentType(FileContentType type);

  protected:
    std::string     filename;
    FILE           *fstream;
    FileAccessMode  mode;
    FileContentType type;
};

}  // namespace datachannel

#endif  // COMMON_DATACHANNEL_FILECHANNEL_H_
